home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / QD3D.a < prev    next >
Encoding:
Text File  |  1997-08-12  |  38.6 KB  |  1,246 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3D.a
  3. ;
  4. ;    Contains:    Base types for Quickdraw 3D                            
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.1
  7. ;                Release:    Universal Interfaces 3.0.1
  8. ;
  9. ;    Copyright:    © 1995-1997 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  19. __QD3D__ SET 1
  20.  
  21.     IF &TYPE('__CONDITIONALMACROS__') = 'UNDEFINED' THEN
  22.     include 'ConditionalMacros.a'
  23.     ENDIF
  24.  
  25.     IF TARGET_OS_MAC THEN
  26.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  27.     include 'Types.a'
  28.     ENDIF
  29.     ENDIF    ; TARGET_OS_MAC
  30.     IF TARGET_OS_MAC THEN
  31.     OS_MACINTOSH: SET 1
  32.     OS_WIN32: SET 0
  33.     OS_UNIX: SET 0
  34.     OS_NEXT: SET 0
  35.     WINDOW_SYSTEM_MACINTOSH: SET 1
  36.     WINDOW_SYSTEM_WIN32: SET 0
  37.     WINDOW_SYSTEM_X11: SET 0
  38.     WINDOW_SYSTEM_NEXT: SET 0
  39.     ENDIF    ; TARGET_OS_MAC
  40.     IF TARGET_OS_WIN32 THEN
  41.     OS_MACINTOSH: SET 0
  42.     OS_WIN32: SET 1
  43.     OS_UNIX: SET 0
  44.     OS_NEXT: SET 0
  45.     WINDOW_SYSTEM_MACINTOSH: SET 0
  46.     WINDOW_SYSTEM_WIN32: SET 1
  47.     WINDOW_SYSTEM_X11: SET 0
  48.     WINDOW_SYSTEM_NEXT: SET 0
  49.     ENDIF    ; TARGET_OS_WIN32
  50.  
  51. ; ******************************************************************************
  52. ; **                                                                             **
  53. ; **                                NULL definition                                 **
  54. ; **                                                                             **
  55. ; ****************************************************************************
  56.  
  57. ; ******************************************************************************
  58. ; **                                                                             **
  59. ; **                                    Objects                                     **
  60. ; **                                                                             **
  61. ; ****************************************************************************
  62.  
  63. ; 
  64. ; * Everything in QuickDraw 3D is an OBJECT: a bunch of data with a type,
  65. ; * deletion, duplication, and i/o methods.
  66. ; 
  67.  
  68.     IF TARGET_OS_MAC THEN
  69. ; typedef FourCharCode                     TQ3ObjectType
  70.  
  71.     ELSE
  72. ; typedef long                             TQ3ObjectType
  73.  
  74.     ENDIF    ; TARGET_OS_MAC
  75.  
  76.  
  77. ; 
  78. ; * There are four subclasses of OBJECT:
  79. ; *    an ELEMENT, which is data that is placed in a SET
  80. ; *    a SHAREDOBJECT, which is reference-counted data that is shared
  81. ; *    VIEWs, which maintain state information for an image
  82. ; *    a PICK, which used to query a VIEW
  83. ; 
  84.  
  85. ; typedef TQ3Object                     TQ3ElementObject
  86.  
  87. ; typedef TQ3Object                     TQ3SharedObject
  88.  
  89. ; typedef TQ3Object                     TQ3ViewObject
  90.  
  91. ; typedef TQ3Object                     TQ3PickObject
  92.  
  93. ; 
  94. ; * There are several types of SharedObjects:
  95. ; *    RENDERERs, which paint to a drawContext
  96. ; *    DRAWCONTEXTs, which are an interface to a device 
  97. ; *    SETs, which maintains "mathematical sets" of ELEMENTs
  98. ; *    FILEs, which maintain state information for a metafile
  99. ; *    SHAPEs, which affect the state of the View
  100. ; *    SHAPEPARTs, which contain geometry-specific data about a picking hit
  101. ; *    CONTROLLERSTATEs, which hold state of the output channels for a CONTROLLER
  102. ; *    TRACKERs, which represent a position and orientation in the user interface
  103. ; *  STRINGs, which are abstractions of text string data.
  104. ; *    STORAGE, which is an abstraction for stream-based data storage (files, memory)
  105. ; *    TEXTUREs, for sharing bitmap information for TEXTURESHADERS
  106. ; *    VIEWHINTs, which specifies viewing preferences in FILEs
  107. ; 
  108.  
  109. ; typedef TQ3SharedObject                 TQ3RendererObject
  110.  
  111. ; typedef TQ3SharedObject                 TQ3DrawContextObject
  112.  
  113. ; typedef TQ3SharedObject                 TQ3SetObject
  114.  
  115. ; typedef TQ3SharedObject                 TQ3FileObject
  116.  
  117. ; typedef TQ3SharedObject                 TQ3ShapeObject
  118.  
  119. ; typedef TQ3SharedObject                 TQ3ShapePartObject
  120.  
  121. ; typedef TQ3SharedObject                 TQ3ControllerStateObject
  122.  
  123. ; typedef TQ3SharedObject                 TQ3TrackerObject
  124.  
  125. ; typedef TQ3SharedObject                 TQ3StringObject
  126.  
  127. ; typedef TQ3SharedObject                 TQ3StorageObject
  128.  
  129. ; typedef TQ3SharedObject                 TQ3TextureObject
  130.  
  131. ; typedef TQ3SharedObject                 TQ3ViewHintsObject
  132.  
  133. ; 
  134. ; * There is one types of SET:
  135. ; *    ATTRIBUTESETs, which contain ATTRIBUTEs which are inherited 
  136. ; 
  137.  
  138. ; typedef TQ3SetObject                     TQ3AttributeSet
  139.  
  140. ; 
  141. ; * There are many types of SHAPEs:
  142. ; *    LIGHTs, which affect how the RENDERER draws 3-D cues
  143. ; *    CAMERAs, which affects the location and orientation of the RENDERER in space
  144. ; *    GROUPs, which may contain any number of SHARED OBJECTS
  145. ; *    GEOMETRYs, which are representations of three-dimensional data
  146. ; *    SHADERs, which affect how colors are drawn on a geometry
  147. ; *    STYLEs, which affect how the RENDERER paints to the DRAWCONTEXT
  148. ; *    TRANSFORMs, which affect the coordinate system in the VIEW
  149. ; *    REFERENCEs, which are references to objects in FILEs
  150. ; *  UNKNOWN, which hold unknown objects read from a metafile.
  151. ; 
  152.  
  153. ; typedef TQ3ShapeObject                 TQ3GroupObject
  154.  
  155. ; typedef TQ3ShapeObject                 TQ3GeometryObject
  156.  
  157. ; typedef TQ3ShapeObject                 TQ3ShaderObject
  158.  
  159. ; typedef TQ3ShapeObject                 TQ3StyleObject
  160.  
  161. ; typedef TQ3ShapeObject                 TQ3TransformObject
  162.  
  163. ; typedef TQ3ShapeObject                 TQ3LightObject
  164.  
  165. ; typedef TQ3ShapeObject                 TQ3CameraObject
  166.  
  167. ; typedef TQ3ShapeObject                 TQ3UnknownObject
  168.  
  169. ; typedef TQ3ShapeObject                 TQ3ReferenceObject
  170.  
  171. ; 
  172. ; * For now, there is only one type of SHAPEPARTs:
  173. ; *    MESHPARTs, which describe some part of a mesh
  174. ; 
  175.  
  176. ; typedef TQ3ShapePartObject             TQ3MeshPartObject
  177.  
  178. ; 
  179. ; * There are three types of MESHPARTs:
  180. ; *    MESHFACEPARTs, which describe a face of a mesh
  181. ; *    MESHEDGEPARTs, which describe a edge of a mesh
  182. ; *    MESHVERTEXPARTs, which describe a vertex of a mesh
  183. ; 
  184.  
  185. ; typedef TQ3MeshPartObject             TQ3MeshFacePartObject
  186.  
  187. ; typedef TQ3MeshPartObject             TQ3MeshEdgePartObject
  188.  
  189. ; typedef TQ3MeshPartObject             TQ3MeshVertexPartObject
  190.  
  191. ; 
  192. ; * A DISPLAY Group can be drawn to a view
  193. ; 
  194.  
  195. ; typedef TQ3GroupObject                 TQ3DisplayGroupObject
  196.  
  197. ; 
  198. ; * There are many types of SHADERs:
  199. ; *    SURFACESHADERs, which affect how the surface of a geometry is painted
  200. ; *    ILLUMINATIONSHADERs, which affect how lights affect the color of a surface
  201. ; 
  202.  
  203. ; typedef TQ3ShaderObject                 TQ3SurfaceShaderObject
  204.  
  205. ; typedef TQ3ShaderObject                 TQ3IlluminationShaderObject
  206.  
  207. ; 
  208. ; * A handle to an object in a group
  209. ; 
  210.  
  211.  
  212.  
  213. ;  
  214. ; * TQ3ObjectClassNameString is used for the class name of an object
  215. ; 
  216.  
  217.  
  218. kQ3StringMaximumLength            EQU        1024
  219. TQ3ObjectClassNameString RECORD 0
  220. elements                 ds.b    1024
  221. sizeof                     EQU *                    ; size:   $400 (1024)
  222.                         ENDR
  223.  
  224.  
  225. ; ******************************************************************************
  226. ; **                                                                             **
  227. ; **                            Client/Server Things                             **
  228. ; **                                                                             **
  229. ; ****************************************************************************
  230.  
  231. ; typedef void *                        TQ3ControllerRef
  232.  
  233. ; ******************************************************************************
  234. ; **                                                                             **
  235. ; **                            Flags and Switches                                 **
  236. ; **                                                                             **
  237. ; ****************************************************************************
  238.  
  239.  
  240. ; typedef long                            TQ3Boolean
  241. kQ3False                        EQU        0
  242. kQ3True                            EQU        1
  243.  
  244. ; typedef long                            TQ3Switch
  245. kQ3Off                            EQU        0
  246. kQ3On                            EQU        1
  247.  
  248. ; typedef long                            TQ3Status
  249. kQ3Failure                        EQU        0
  250. kQ3Success                        EQU        1
  251.  
  252. ; typedef long                            TQ3Axis
  253. kQ3AxisX                        EQU        0
  254. kQ3AxisY                        EQU        1
  255. kQ3AxisZ                        EQU        2
  256.  
  257. ; typedef long                            TQ3PixelType
  258. kQ3PixelTypeRGB32                EQU        0                    ; Alpha:8 (ignored), R:8, G:8, B:8    
  259. kQ3PixelTypeARGB32                EQU        1                    ; Alpha:8, R:8, G:8, B:8             
  260. kQ3PixelTypeRGB16                EQU        2                    ; Alpha:1 (ignored), R:5, G:5, B:5    
  261. kQ3PixelTypeARGB16                EQU        3                    ; Alpha:1, R:5, G:5, B:5             
  262. kQ3PixelTypeRGB16_565            EQU        4                    ; Win32 only: 16 bits/pixel, R:5, G:6, B:5        
  263. kQ3PixelTypeRGB24                EQU        5                    ; Win32 only: 24 bits/pixel, R:8, G:8, B:8        
  264.  
  265. ; typedef long                            TQ3Endian
  266. kQ3EndianBig                    EQU        0
  267. kQ3EndianLittle                    EQU        1
  268.  
  269. ; typedef long                            TQ3EndCapMasks
  270. kQ3EndCapNone                    EQU        0
  271. kQ3EndCapMaskTop                EQU        $01
  272. kQ3EndCapMaskBottom                EQU        $02
  273. kQ3EndCapMaskInterior            EQU        $04
  274. ; typedef unsigned long                 TQ3EndCap
  275.  
  276.  
  277. kQ3ArrayIndexNULL                EQU        -1
  278. ; ******************************************************************************
  279. ; **                                                                             **
  280. ; **                        Point and Vector Definitions                         **
  281. ; **                                                                             **
  282. ; ****************************************************************************
  283.  
  284. TQ3Vector2D                RECORD 0
  285. x                         ds        Float32            ; offset: $0 (0)
  286. y                         ds        Float32            ; offset: $4 (4)
  287. sizeof                     EQU *                    ; size:   $8 (8)
  288.                         ENDR
  289. TQ3Vector3D                RECORD 0
  290. x                         ds        Float32            ; offset: $0 (0)
  291. y                         ds        Float32            ; offset: $4 (4)
  292. z                         ds        Float32            ; offset: $8 (8)
  293. sizeof                     EQU *                    ; size:   $C (12)
  294.                         ENDR
  295. TQ3Point2D                RECORD 0
  296. x                         ds        Float32            ; offset: $0 (0)
  297. y                         ds        Float32            ; offset: $4 (4)
  298. sizeof                     EQU *                    ; size:   $8 (8)
  299.                         ENDR
  300. TQ3Point3D                RECORD 0
  301. x                         ds        Float32            ; offset: $0 (0)
  302. y                         ds        Float32            ; offset: $4 (4)
  303. z                         ds        Float32            ; offset: $8 (8)
  304. sizeof                     EQU *                    ; size:   $C (12)
  305.                         ENDR
  306. TQ3RationalPoint4D        RECORD 0
  307. x                         ds        Float32            ; offset: $0 (0)
  308. y                         ds        Float32            ; offset: $4 (4)
  309. z                         ds        Float32            ; offset: $8 (8)
  310. w                         ds        Float32            ; offset: $C (12)
  311. sizeof                     EQU *                    ; size:   $10 (16)
  312.                         ENDR
  313. TQ3RationalPoint3D        RECORD 0
  314. x                         ds        Float32            ; offset: $0 (0)
  315. y                         ds        Float32            ; offset: $4 (4)
  316. w                         ds        Float32            ; offset: $8 (8)
  317. sizeof                     EQU *                    ; size:   $C (12)
  318.                         ENDR
  319. ; ******************************************************************************
  320. ; **                                                                             **
  321. ; **                                Quaternion                                     **
  322. ; **                                                                             **
  323. ; ****************************************************************************
  324.  
  325. TQ3Quaternion            RECORD 0
  326. w                         ds        Float32            ; offset: $0 (0)
  327. x                         ds        Float32            ; offset: $4 (4)
  328. y                         ds        Float32            ; offset: $8 (8)
  329. z                         ds        Float32            ; offset: $C (12)
  330. sizeof                     EQU *                    ; size:   $10 (16)
  331.                         ENDR
  332. ; ******************************************************************************
  333. ; **                                                                             **
  334. ; **                                Ray Definition                                 **
  335. ; **                                                                             **
  336. ; ****************************************************************************
  337.  
  338. TQ3Ray3D                RECORD 0
  339. origin                     ds        TQ3Point3D        ; offset: $0 (0)
  340. direction                 ds        TQ3Vector3D        ; offset: $C (12)
  341. sizeof                     EQU *                    ; size:   $18 (24)
  342.                         ENDR
  343. ; ******************************************************************************
  344. ; **                                                                             **
  345. ; **                        Parameterization Data Structures                     **
  346. ; **                                                                             **
  347. ; ****************************************************************************
  348.  
  349. TQ3Param2D                RECORD 0
  350. u                         ds        Float32            ; offset: $0 (0)
  351. v                         ds        Float32            ; offset: $4 (4)
  352. sizeof                     EQU *                    ; size:   $8 (8)
  353.                         ENDR
  354. TQ3Param3D                RECORD 0
  355. u                         ds        Float32            ; offset: $0 (0)
  356. v                         ds        Float32            ; offset: $4 (4)
  357. w                         ds        Float32            ; offset: $8 (8)
  358. sizeof                     EQU *                    ; size:   $C (12)
  359.                         ENDR
  360. TQ3Tangent2D            RECORD 0
  361. uTangent                 ds        TQ3Vector3D        ; offset: $0 (0)
  362. vTangent                 ds        TQ3Vector3D        ; offset: $C (12)
  363. sizeof                     EQU *                    ; size:   $18 (24)
  364.                         ENDR
  365. TQ3Tangent3D            RECORD 0
  366. uTangent                 ds        TQ3Vector3D        ; offset: $0 (0)
  367. vTangent                 ds        TQ3Vector3D        ; offset: $C (12)
  368. wTangent                 ds        TQ3Vector3D        ; offset: $18 (24)
  369. sizeof                     EQU *                    ; size:   $24 (36)
  370.                         ENDR
  371. ; ******************************************************************************
  372. ; **                                                                             **
  373. ; **                        Polar and Spherical Coordinates                         **
  374. ; **                                                                             **
  375. ; ****************************************************************************
  376.  
  377. TQ3PolarPoint            RECORD 0
  378. r                         ds        Float32            ; offset: $0 (0)
  379. theta                     ds        Float32            ; offset: $4 (4)
  380. sizeof                     EQU *                    ; size:   $8 (8)
  381.                         ENDR
  382. TQ3SphericalPoint        RECORD 0
  383. rho                         ds        Float32            ; offset: $0 (0)
  384. theta                     ds        Float32            ; offset: $4 (4)
  385. phi                         ds        Float32            ; offset: $8 (8)
  386. sizeof                     EQU *                    ; size:   $C (12)
  387.                         ENDR
  388. ; ******************************************************************************
  389. ; **                                                                             **
  390. ; **                            Color Definition                                 **
  391. ; **                                                                             **
  392. ; ****************************************************************************
  393.  
  394. TQ3ColorRGB                RECORD 0
  395. r                         ds        Float32            ; offset: $0 (0)
  396. g                         ds        Float32            ; offset: $4 (4)
  397. b                         ds        Float32            ; offset: $8 (8)
  398. sizeof                     EQU *                    ; size:   $C (12)
  399.                         ENDR
  400. TQ3ColorARGB            RECORD 0
  401. a                         ds        Float32            ; offset: $0 (0)
  402. r                         ds        Float32            ; offset: $4 (4)
  403. g                         ds        Float32            ; offset: $8 (8)
  404. b                         ds        Float32            ; offset: $C (12)
  405. sizeof                     EQU *                    ; size:   $10 (16)
  406.                         ENDR
  407. ; ******************************************************************************
  408. ; **                                                                             **
  409. ; **                                    Vertices                                 **
  410. ; **                                                                             **
  411. ; ****************************************************************************
  412.  
  413. TQ3Vertex3D                RECORD 0
  414. point                     ds        TQ3Point3D        ; offset: $0 (0)
  415. attributeSet             ds.l    1                ; offset: $C (12)
  416. sizeof                     EQU *                    ; size:   $10 (16)
  417.                         ENDR
  418. ; ******************************************************************************
  419. ; **                                                                             **
  420. ; **                                    Matrices                                 **
  421. ; **                                                                             **
  422. ; ****************************************************************************
  423.  
  424. TQ3Matrix3x3            RECORD 0
  425. value                     ds.b    3 * 3 * Float32.sizeof ; offset: $0 (0)
  426. sizeof                     EQU *                    ; size:   $24 (36)
  427.                         ENDR
  428. TQ3Matrix4x4            RECORD 0
  429. value                     ds.b    4 * 4 * Float32.sizeof ; offset: $0 (0)
  430. sizeof                     EQU *                    ; size:   $40 (64)
  431.                         ENDR
  432. ; ******************************************************************************
  433. ; **                                                                             **
  434. ; **                                Bitmap/Pixmap                                 **
  435. ; **                                                                             **
  436. ; ****************************************************************************
  437.  
  438. TQ3Pixmap                RECORD 0
  439. image                     ds.l    1                ; offset: $0 (0)
  440. width                     ds.l    1                ; offset: $4 (4)
  441. height                     ds.l    1                ; offset: $8 (8)
  442. rowBytes                 ds.l    1                ; offset: $C (12)
  443. pixelSize                 ds.l    1                ; offset: $10 (16)        ;  MUST be 16 or 32 to use with the    Interactive Renderer on Mac OS
  444. pixelType                 ds.l    1                ; offset: $14 (20)
  445. bitOrder                 ds.l    1                ; offset: $18 (24)
  446. byteOrder                 ds.l    1                ; offset: $1C (28)
  447. sizeof                     EQU *                    ; size:   $20 (32)
  448.                         ENDR
  449. TQ3StoragePixmap        RECORD 0
  450. image                     ds.l    1                ; offset: $0 (0)
  451. width                     ds.l    1                ; offset: $4 (4)
  452. height                     ds.l    1                ; offset: $8 (8)
  453. rowBytes                 ds.l    1                ; offset: $C (12)
  454. pixelSize                 ds.l    1                ; offset: $10 (16)        ;  MUST be 16 or 32 to use with the    Interactive Renderer on Mac OS
  455. pixelType                 ds.l    1                ; offset: $14 (20)
  456. bitOrder                 ds.l    1                ; offset: $18 (24)
  457. byteOrder                 ds.l    1                ; offset: $1C (28)
  458. sizeof                     EQU *                    ; size:   $20 (32)
  459.                         ENDR
  460. TQ3Bitmap                RECORD 0
  461. image                     ds.l    1                ; offset: $0 (0)
  462. width                     ds.l    1                ; offset: $4 (4)
  463. height                     ds.l    1                ; offset: $8 (8)
  464. rowBytes                 ds.l    1                ; offset: $C (12)
  465. bitOrder                 ds.l    1                ; offset: $10 (16)
  466. sizeof                     EQU *                    ; size:   $14 (20)
  467.                         ENDR
  468. TQ3MipmapImage            RECORD 0
  469. ;  An image for use as a texture mipmap  
  470. width                     ds.l    1                ; offset: $0 (0)        ;  Width of mipmap, must be power of 2   
  471. height                     ds.l    1                ; offset: $4 (4)        ;  Height of mipmap, must be power of 2  
  472. rowBytes                 ds.l    1                ; offset: $8 (8)        ;  Rowbytes of mipmap                    
  473. offset                     ds.l    1                ; offset: $C (12)        ;  Offset from image base to this mipmap 
  474. sizeof                     EQU *                    ; size:   $10 (16)
  475.                         ENDR
  476. TQ3Mipmap                RECORD 0
  477. image                     ds.l    1                ; offset: $0 (0)        ;  Data containing the texture map and     
  478. ;  if (useMipmapping==kQ3True) the         
  479. ;  mipmap data                             
  480. useMipmapping             ds.l    1                ; offset: $4 (4)        ;  True if mipmapping should be used     
  481. ;  and all mipmaps have been provided   
  482. pixelType                 ds.l    1                ; offset: $8 (8)
  483. bitOrder                 ds.l    1                ; offset: $C (12)
  484. byteOrder                 ds.l    1                ; offset: $10 (16)
  485. reserved                 ds.l    1                ; offset: $14 (20)        ;  leave NULL for next version 
  486. mipmaps                     ds.b    32 * TQ3MipmapImage.sizeof ; offset: $18 (24) ;  The actual number of mipmaps is         
  487. ;  determined from the size of the         
  488. ;  first mipmap                            
  489. sizeof                     EQU *                    ; size:   $218 (536)
  490.                         ENDR
  491. ;
  492. ; extern TQ3Status Q3Bitmap_Empty(TQ3Bitmap *bitmap)
  493. ;
  494.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  495.         IMPORT_CFM_FUNCTION Q3Bitmap_Empty
  496.     ENDIF
  497.  
  498. ;
  499. ; extern unsigned long Q3Bitmap_GetImageSize(unsigned long width, unsigned long height)
  500. ;
  501.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  502.         IMPORT_CFM_FUNCTION Q3Bitmap_GetImageSize
  503.     ENDIF
  504.  
  505.  
  506. ; ******************************************************************************
  507. ; **                                                                             **
  508. ; **                        Higher dimension quantities                             **
  509. ; **                                                                             **
  510. ; ****************************************************************************
  511.  
  512. TQ3Area                    RECORD 0
  513. min                         ds        TQ3Point2D        ; offset: $0 (0)
  514. max                         ds        TQ3Point2D        ; offset: $8 (8)
  515. sizeof                     EQU *                    ; size:   $10 (16)
  516.                         ENDR
  517. TQ3PlaneEquation        RECORD 0
  518. normal                     ds        TQ3Vector3D        ; offset: $0 (0)
  519. constant                 ds        Float32            ; offset: $C (12)
  520. sizeof                     EQU *                    ; size:   $10 (16)
  521.                         ENDR
  522. TQ3BoundingBox            RECORD 0
  523. min                         ds        TQ3Point3D        ; offset: $0 (0)
  524. max                         ds        TQ3Point3D        ; offset: $C (12)
  525. isEmpty                     ds.l    1                ; offset: $18 (24)
  526. sizeof                     EQU *                    ; size:   $1C (28)
  527.                         ENDR
  528. TQ3BoundingSphere        RECORD 0
  529. origin                     ds        TQ3Point3D        ; offset: $0 (0)
  530. radius                     ds        Float32            ; offset: $C (12)
  531. isEmpty                     ds.l    1                ; offset: $10 (16)
  532. sizeof                     EQU *                    ; size:   $14 (20)
  533.                         ENDR
  534. ; 
  535. ; *    The TQ3ComputeBounds flag passed to StartBoundingBox or StartBoundingSphere
  536. ; *    calls in the View. It's a hint to the system as to how it should 
  537. ; *    compute the bbox of a shape:
  538. ; *
  539. ; *    kQ3ComputeBoundsExact:    
  540. ; *        Vertices of shapes are transformed into world space and
  541. ; *        the world space bounding box is computed from them.  Slow!
  542. ; *    
  543. ; *    kQ3ComputeBoundsApproximate: 
  544. ; *        A local space bounding box is computed from a shape's
  545. ; *        vertices.  This bbox is then transformed into world space,
  546. ; *        and its bounding box is taken as the shape's approximate
  547. ; *        bbox.  Fast but the bbox is larger than optimal.
  548. ; 
  549.  
  550.  
  551. ; typedef long                            TQ3ComputeBounds
  552. kQ3ComputeBoundsExact            EQU        0
  553. kQ3ComputeBoundsApproximate        EQU        1
  554.  
  555. ; ******************************************************************************
  556. ; **                                                                             **
  557. ; **                            Object System Types                                 **
  558. ; **                                                                             **
  559. ; ****************************************************************************
  560.  
  561.  
  562.  
  563. ; typedef unsigned long                 TQ3MethodType
  564.  
  565. ; 
  566. ; * Object methods
  567. ; 
  568.  
  569. ; 
  570. ; * IO Methods
  571. ; 
  572.  
  573. ; 
  574. ; * MetaHandler:
  575. ; *        When you give a metahandler to QuickDraw 3D, it is called multiple times to
  576. ; *        build method tables, and then is thrown away. You are guaranteed that
  577. ; *        your metahandler will never be called again after a call that was passed
  578. ; *        a metahandler returns.
  579. ; *
  580. ; *        Your metahandler should contain a switch on the methodType passed to it
  581. ; *        and should return the corresponding method as an TQ3FunctionPointer.
  582. ; *
  583. ; *        IMPORTANT: A metaHandler MUST always "return" a value. If you are
  584. ; *        passed a methodType that you do not understand, ALWAYS return NULL.
  585. ; *
  586. ; *        These types here are prototypes of how your functions should look.
  587. ; 
  588.  
  589.  
  590.  
  591. ; typedef unsigned long                 TQ3XMethodType
  592.  
  593. ; 
  594. ; * Object methods
  595. ; 
  596.  
  597. ; 
  598. ; * MetaHandler:
  599. ; *        When you give a metahandler to QuickDraw 3D, it is called multiple 
  600. ; *        times to build method tables, and then is thrown away. You are 
  601. ; *        guaranteed that your metahandler will never be called again after a 
  602. ; *        call that was passed a metahandler returns.
  603. ; *
  604. ; *        Your metahandler should contain a switch on the methodType passed to it
  605. ; *        and should return the corresponding method as an TQ3XFunctionPointer.
  606. ; *
  607. ; *        IMPORTANT: A metaHandler MUST always "return" a value. If you are
  608. ; *        passed a methodType that you do not understand, ALWAYS return NULL.
  609. ; *
  610. ; *        These types here are prototypes of how your functions should look.
  611. ; 
  612.  
  613. ; 
  614. ; * See QD3DIO.h for the IO method types: 
  615. ; *        ObjectReadData, ObjectTraverse, ObjectWrite
  616. ; 
  617.  
  618.  
  619. ; ******************************************************************************
  620. ; **                                                                             **
  621. ; **                                Set Types                                     **
  622. ; **                                                                             **
  623. ; ****************************************************************************
  624.  
  625. ; typedef long                             TQ3ElementType
  626.  
  627.  
  628. kQ3ElementTypeNone                EQU        0
  629. kQ3ElementTypeUnknown            EQU        32
  630. kQ3ElementTypeSet                EQU        33
  631. ;  
  632. ; *    kQ3ElementTypeUnknown is a TQ3Object. 
  633. ; *    
  634. ; *        Do Q3Set_Add(s, ..., &obj) or Q3Set_Get(s, ..., &obj);
  635. ; *        
  636. ; *        Note that the object is always referenced when copying around. 
  637. ; *        
  638. ; *        Generally, it is an Unknown object, a Group of Unknown objects, or a 
  639. ; *        group of other "objects" which have been found in the metafile and
  640. ; *        have no attachment method to their parent. Be prepared to handle
  641. ; *        any or all of these cases if you actually access the set on a shape.
  642. ; *
  643. ; *    kQ3ElementTypeSet is a TQ3SetObject. 
  644. ; *    
  645. ; *        Q3Shape_GetSet(s,&o) is eqivalent to 
  646. ; *            Q3Shape_GetElement(s, kQ3ElementTypeSet, &o)
  647. ; *            
  648. ; *        Q3Shape_SetSet(s,o)  is eqivalent to 
  649. ; *            Q3Shape_SetElement(s, kQ3ElementTypeSet, &o)
  650. ; *    
  651. ; *        Note that the object is always referenced when copying around. 
  652. ; *        
  653. ; *    See the note below about the Set and Shape changes.
  654. ; 
  655.  
  656.  
  657. ; ******************************************************************************
  658. ; **                                                                             **
  659. ; **                            Object System Macros                             **
  660. ; **                                                                             **
  661. ; ****************************************************************************
  662.  
  663. ; ******************************************************************************
  664. ; **                                                                             **
  665. ; **                                Object Types                                 **
  666. ; **                                                                             **
  667. ; ****************************************************************************
  668.  
  669. ; 
  670. ; * Note:    a call to Q3Foo_GetType will return a value kQ3FooTypeBar
  671. ; *            e.g. Q3Shared_GetType(object) returns kQ3SharedTypeShape, etc.
  672. ; 
  673.  
  674.  
  675. kQ3ObjectTypeInvalid            EQU        0
  676. kQ3ObjectTypeView                EQU        'view'
  677. kQ3ObjectTypeElement            EQU        'elmn'
  678. kQ3ElementTypeAttribute            EQU        'eatt'
  679. kQ3ObjectTypePick                EQU        'pick'
  680. kQ3PickTypeWindowPoint            EQU        'pkwp'
  681. kQ3PickTypeWindowRect            EQU        'pkwr'
  682. kQ3ObjectTypeShared                EQU        'shrd'
  683. kQ3SharedTypeRenderer            EQU        'rddr'
  684. kQ3RendererTypeWireFrame        EQU        'wrfr'
  685. kQ3RendererTypeGeneric            EQU        'gnrr'
  686. kQ3RendererTypeInteractive        EQU        'ctwn'
  687. kQ3SharedTypeShape                EQU        'shap'
  688. kQ3ShapeTypeGeometry            EQU        'gmtr'
  689. kQ3GeometryTypeBox                EQU        'box '
  690. kQ3GeometryTypeGeneralPolygon    EQU        'gpgn'
  691. kQ3GeometryTypeLine                EQU        'line'
  692. kQ3GeometryTypeMarker            EQU        'mrkr'
  693. kQ3GeometryTypePixmapMarker        EQU        'mrkp'
  694. kQ3GeometryTypeMesh                EQU        'mesh'
  695. kQ3GeometryTypeNURBCurve        EQU        'nrbc'
  696. kQ3GeometryTypeNURBPatch        EQU        'nrbp'
  697. kQ3GeometryTypePoint            EQU        'pnt '
  698. kQ3GeometryTypePolygon            EQU        'plyg'
  699. kQ3GeometryTypePolyLine            EQU        'plyl'
  700. kQ3GeometryTypeTriangle            EQU        'trng'
  701. kQ3GeometryTypeTriGrid            EQU        'trig'
  702. kQ3GeometryTypeCone                EQU        'cone'
  703. kQ3GeometryTypeCylinder            EQU        'cyln'
  704. kQ3GeometryTypeDisk                EQU        'disk'
  705. kQ3GeometryTypeEllipse            EQU        'elps'
  706. kQ3GeometryTypeEllipsoid        EQU        'elpd'
  707. kQ3GeometryTypePolyhedron        EQU        'plhd'
  708. kQ3GeometryTypeTorus            EQU        'tors'
  709. kQ3GeometryTypeTriMesh            EQU        'tmsh'
  710. kQ3ShapeTypeShader                EQU        'shdr'
  711. kQ3ShaderTypeSurface            EQU        'sush'
  712. kQ3SurfaceShaderTypeTexture        EQU        'txsu'
  713. kQ3ShaderTypeIllumination        EQU        'ilsh'
  714. kQ3IlluminationTypePhong        EQU        'phil'
  715. kQ3IlluminationTypeLambert        EQU        'lmil'
  716. kQ3IlluminationTypeNULL            EQU        'nuil'
  717. kQ3ShapeTypeStyle                EQU        'styl'
  718. kQ3StyleTypeBackfacing            EQU        'bckf'
  719. kQ3StyleTypeInterpolation        EQU        'intp'
  720. kQ3StyleTypeFill                EQU        'fist'
  721. kQ3StyleTypePickID                EQU        'pkid'
  722. kQ3StyleTypeReceiveShadows        EQU        'rcsh'
  723. kQ3StyleTypeHighlight            EQU        'high'
  724. kQ3StyleTypeSubdivision            EQU        'sbdv'
  725. kQ3StyleTypeOrientation            EQU        'ofdr'
  726. kQ3StyleTypePickParts            EQU        'pkpt'
  727. kQ3StyleTypeAntiAlias            EQU        'anti'
  728. kQ3ShapeTypeTransform            EQU        'xfrm'
  729. kQ3TransformTypeMatrix            EQU        'mtrx'
  730. kQ3TransformTypeScale            EQU        'scal'
  731. kQ3TransformTypeTranslate        EQU        'trns'
  732. kQ3TransformTypeRotate            EQU        'rott'
  733. kQ3TransformTypeRotateAboutPoint EQU    'rtap'
  734. kQ3TransformTypeRotateAboutAxis    EQU        'rtaa'
  735. kQ3TransformTypeQuaternion        EQU        'qtrn'
  736. kQ3TransformTypeReset            EQU        'rset'
  737. kQ3ShapeTypeLight                EQU        'lght'
  738. kQ3LightTypeAmbient                EQU        'ambn'
  739. kQ3LightTypeDirectional            EQU        'drct'
  740. kQ3LightTypePoint                EQU        'pntl'
  741. kQ3LightTypeSpot                EQU        'spot'
  742. kQ3ShapeTypeCamera                EQU        'cmra'
  743. kQ3CameraTypeOrthographic        EQU        'orth'
  744. kQ3CameraTypeViewPlane            EQU        'vwpl'
  745. kQ3CameraTypeViewAngleAspect    EQU        'vana'
  746. kQ3ShapeTypeGroup                EQU        'grup'
  747. kQ3GroupTypeDisplay                EQU        'dspg'
  748. kQ3DisplayGroupTypeOrdered        EQU        'ordg'
  749. kQ3DisplayGroupTypeIOProxy        EQU        'iopx'
  750. kQ3GroupTypeLight                EQU        'lghg'
  751. kQ3GroupTypeInfo                EQU        'info'
  752. kQ3ShapeTypeUnknown                EQU        'unkn'
  753. kQ3UnknownTypeText                EQU        'uktx'
  754. kQ3UnknownTypeBinary            EQU        'ukbn'
  755. kQ3ShapeTypeReference            EQU        'rfrn'
  756. kQ3ReferenceTypeExternal        EQU        'rfex'
  757. kQ3SharedTypeSet                EQU        'set '
  758. kQ3SetTypeAttribute                EQU        'attr'
  759. kQ3SharedTypeDrawContext        EQU        'dctx'
  760. kQ3DrawContextTypePixmap        EQU        'dpxp'
  761. kQ3DrawContextTypeMacintosh        EQU        'dmac'
  762. kQ3DrawContextTypeWin32DC        EQU        'dw32'
  763. kQ3DrawContextTypeDDSurface        EQU        'ddds'
  764. kQ3DrawContextTypeX11            EQU        'dx11'
  765. kQ3SharedTypeTexture            EQU        'txtr'
  766. kQ3TextureTypePixmap            EQU        'txpm'
  767. kQ3SharedTypeFile                EQU        'file'
  768. kQ3SharedTypeStorage            EQU        'strg'
  769. kQ3StorageTypeMemory            EQU        'mems'
  770. kQ3MemoryStorageTypeHandle        EQU        'hndl'
  771. kQ3StorageTypeUnix                EQU        'uxst'
  772. kQ3UnixStorageTypePath            EQU        'unix'
  773. kQ3StorageTypeMacintosh            EQU        'macn'
  774. kQ3MacintoshStorageTypeFSSpec    EQU        'macp'
  775. kQ3StorageTypeWin32                EQU        'wist'
  776. kQ3SharedTypeString                EQU        'strn'
  777. kQ3StringTypeCString            EQU        'strc'
  778. kQ3SharedTypeShapePart            EQU        'sprt'
  779. kQ3ShapePartTypeMeshPart        EQU        'spmh'
  780. kQ3MeshPartTypeMeshFacePart        EQU        'mfac'
  781. kQ3MeshPartTypeMeshEdgePart        EQU        'medg'
  782. kQ3MeshPartTypeMeshVertexPart    EQU        'mvtx'
  783. kQ3SharedTypeControllerState    EQU        'ctst'
  784. kQ3SharedTypeTracker            EQU        'trkr'
  785. kQ3SharedTypeViewHints            EQU        'vwhn'
  786. kQ3SharedTypeEndGroup            EQU        'endg'
  787. kQ3ObjectTypeEndGroup            EQU        'endg'
  788. ; ******************************************************************************
  789. ; **                                                                             **
  790. ; **                            QuickDraw 3D System Routines                     **
  791. ; **                                                                             **
  792. ; ****************************************************************************
  793.  
  794. ;
  795. ; extern TQ3Status Q3Initialize(void )
  796. ;
  797.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  798.         IMPORT_CFM_FUNCTION Q3Initialize
  799.     ENDIF
  800.  
  801. ;
  802. ; extern TQ3Status Q3Exit(void )
  803. ;
  804.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  805.         IMPORT_CFM_FUNCTION Q3Exit
  806.     ENDIF
  807.  
  808. ;
  809. ; extern TQ3Boolean Q3IsInitialized(void )
  810. ;
  811.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  812.         IMPORT_CFM_FUNCTION Q3IsInitialized
  813.     ENDIF
  814.  
  815. ;
  816. ; extern TQ3Status Q3GetVersion(unsigned long *majorRevision, unsigned long *minorRevision)
  817. ;
  818.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  819.         IMPORT_CFM_FUNCTION Q3GetVersion
  820.     ENDIF
  821.  
  822. ; 
  823. ; *  Q3GetReleaseVersion returns the release version number,
  824. ; *  in the format of the first four bytes of a 'vers' resource
  825. ; *  (e.g. 0x01518000 ==> 1.5.1 release).
  826. ; 
  827.  
  828. ;
  829. ; extern TQ3Status Q3GetReleaseVersion(unsigned long *releaseRevision)
  830. ;
  831.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  832.         IMPORT_CFM_FUNCTION Q3GetReleaseVersion
  833.     ENDIF
  834.  
  835.  
  836. ; ******************************************************************************
  837. ; **                                                                             **
  838. ; **                            ObjectClass Routines                             **
  839. ; **                                                                             **
  840. ; ****************************************************************************
  841.  
  842. ; 
  843. ; *  Q3ObjectClass_Unregister is an obsolete function.  For the new extensions 
  844. ; *  model you should now use Q3XObjectHierarchy_UnregisterClass which is 
  845. ; *  defined in QD3DExtension.h and takes identical parameters.
  846. ; 
  847.  
  848. ;
  849. ; extern TQ3Status Q3ObjectClass_Unregister(TQ3ObjectClass objectClass)
  850. ;
  851.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  852.         IMPORT_CFM_FUNCTION Q3ObjectClass_Unregister
  853.     ENDIF
  854.  
  855.  
  856. ;  
  857. ; *  New object system calls to query the object system.
  858. ; *
  859. ; *  These comments to move to the stubs file before final release, they 
  860. ; *  are here for documentation for developers using early seeds.
  861. ; 
  862.  
  863. ; 
  864. ; *  Given a class name as a string return the associated class type for the 
  865. ; *  class, may return kQ3Failure if the string representing the class is 
  866. ; *  invalid.
  867. ; 
  868.  
  869. ;
  870. ; extern TQ3Status Q3ObjectHierarchy_GetTypeFromString(TQ3ObjectClassNameString objectClassString, TQ3ObjectType *objectClassType)
  871. ;
  872.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  873.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_GetTypeFromString
  874.     ENDIF
  875.  
  876. ; 
  877. ; *  Given a class type as return the associated string for the class name, 
  878. ; *  may return kQ3Failure if the type representing the class is invalid.
  879. ; 
  880.  
  881. ;
  882. ; extern TQ3Status Q3ObjectHierarchy_GetStringFromType(TQ3ObjectType objectClassType, TQ3ObjectClassNameString objectClassString)
  883. ;
  884.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  885.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_GetStringFromType
  886.     ENDIF
  887.  
  888. ;  
  889. ; *  Return true if the class with this type is registered, false if not 
  890. ; 
  891.  
  892. ;
  893. ; extern TQ3Boolean Q3ObjectHierarchy_IsTypeRegistered(TQ3ObjectType objectClassType)
  894. ;
  895.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  896.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_IsTypeRegistered
  897.     ENDIF
  898.  
  899. ;  
  900. ; *  Return true if the class with this name is registered, false if not 
  901. ; 
  902.  
  903. ;
  904. ; extern TQ3Boolean Q3ObjectHierarchy_IsNameRegistered(const char *objectClassName)
  905. ;
  906.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  907.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_IsNameRegistered
  908.     ENDIF
  909.  
  910. ; 
  911. ; * TQ3SubClassData is used when querying the object system for
  912. ; * the subclasses of a particular parent type:
  913. ; 
  914.  
  915. TQ3SubClassData            RECORD 0
  916. numClasses                 ds.l    1                ; offset: $0 (0)        ;  the # of subclass types found for a parent class 
  917. classTypes                 ds.l    1                ; offset: $4 (4)        ;  an array containing the class types 
  918. sizeof                     EQU *                    ; size:   $8 (8)
  919.                         ENDR
  920. ; 
  921. ; *  Given a parent type and an instance of the TQ3SubClassData struct fill
  922. ; *  it in with the number and class types of all of the subclasses immediately
  923. ; *  below the parent in the class hierarchy.  Return kQ3Success to indicate no
  924. ; *  errors occurred, else kQ3Failure.
  925. ; *
  926. ; *  NOTE:  This function will allocate memory for the classTypes array.  Be 
  927. ; *    sure to call Q3ObjectClass_EmptySubClassData to free this memory up.
  928. ; 
  929.  
  930. ;
  931. ; extern TQ3Status Q3ObjectHierarchy_GetSubClassData(TQ3ObjectType objectClassType, TQ3SubClassData *subClassData)
  932. ;
  933.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  934.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_GetSubClassData
  935.     ENDIF
  936.  
  937. ; 
  938. ; *  Given an instance of the TQ3SubClassData struct free all memory allocated 
  939. ; *    by the Q3ObjectClass_GetSubClassData call.
  940. ; *
  941. ; *  NOTE: This call MUST be made after a call to Q3ObjectClass_GetSubClassData
  942. ; *  to avoid memory leaks.
  943. ; 
  944.  
  945. ;
  946. ; extern TQ3Status Q3ObjectHierarchy_EmptySubClassData(TQ3SubClassData *subClassData)
  947. ;
  948.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  949.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_EmptySubClassData
  950.     ENDIF
  951.  
  952.  
  953. ; ******************************************************************************
  954. ; **                                                                             **
  955. ; **                                Object Routines                                 **
  956. ; **                                                                             **
  957. ; ****************************************************************************
  958.  
  959. ;
  960. ; extern TQ3Status Q3Object_Dispose(TQ3Object object)
  961. ;
  962.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  963.         IMPORT_CFM_FUNCTION Q3Object_Dispose
  964.     ENDIF
  965.  
  966. ;
  967. ; extern TQ3Object Q3Object_Duplicate(TQ3Object object)
  968. ;
  969.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  970.         IMPORT_CFM_FUNCTION Q3Object_Duplicate
  971.     ENDIF
  972.  
  973. ;
  974. ; extern TQ3Status Q3Object_Submit(TQ3Object object, TQ3ViewObject view)
  975. ;
  976.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  977.         IMPORT_CFM_FUNCTION Q3Object_Submit
  978.     ENDIF
  979.  
  980. ;
  981. ; extern TQ3Boolean Q3Object_IsDrawable(TQ3Object object)
  982. ;
  983.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  984.         IMPORT_CFM_FUNCTION Q3Object_IsDrawable
  985.     ENDIF
  986.  
  987. ;
  988. ; extern TQ3Boolean Q3Object_IsWritable(TQ3Object object, TQ3FileObject theFile)
  989. ;
  990.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  991.         IMPORT_CFM_FUNCTION Q3Object_IsWritable
  992.     ENDIF
  993.  
  994.  
  995. ; ******************************************************************************
  996. ; **                                                                             **
  997. ; **                            Object Type Routines                             **
  998. ; **                                                                             **
  999. ; ****************************************************************************
  1000.  
  1001. ;
  1002. ; extern TQ3ObjectType Q3Object_GetType(TQ3Object object)
  1003. ;
  1004.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1005.         IMPORT_CFM_FUNCTION Q3Object_GetType
  1006.     ENDIF
  1007.  
  1008. ;
  1009. ; extern TQ3ObjectType Q3Object_GetLeafType(TQ3Object object)
  1010. ;
  1011.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1012.         IMPORT_CFM_FUNCTION Q3Object_GetLeafType
  1013.     ENDIF
  1014.  
  1015. ;
  1016. ; extern TQ3Boolean Q3Object_IsType(TQ3Object object, TQ3ObjectType theType)
  1017. ;
  1018.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1019.         IMPORT_CFM_FUNCTION Q3Object_IsType
  1020.     ENDIF
  1021.  
  1022.  
  1023. ; ******************************************************************************
  1024. ; **                                                                             **
  1025. ; **                            Shared Object Routines                             **
  1026. ; **                                                                             **
  1027. ; ****************************************************************************
  1028.  
  1029. ;
  1030. ; extern TQ3ObjectType Q3Shared_GetType(TQ3SharedObject sharedObject)
  1031. ;
  1032.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1033.         IMPORT_CFM_FUNCTION Q3Shared_GetType
  1034.     ENDIF
  1035.  
  1036. ;
  1037. ; extern TQ3SharedObject Q3Shared_GetReference(TQ3SharedObject sharedObject)
  1038. ;
  1039.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1040.         IMPORT_CFM_FUNCTION Q3Shared_GetReference
  1041.     ENDIF
  1042.  
  1043. ;  
  1044. ; *    Q3Shared_IsReferenced
  1045. ; *        Returns kQ3True if there is more than one reference to sharedObject.
  1046. ; *        Returns kQ3False if there is ONE reference to sharedObject.
  1047. ; *    
  1048. ; *    This call is intended to allow applications and plug-in objects to delete
  1049. ; *    objects of which they hold THE ONLY REFERENCE. This is useful when
  1050. ; *    caching objects, etc.
  1051. ; *    
  1052. ; *    Although many may be tempted, DO NOT DO THIS:
  1053. ; *        while (Q3Shared_IsReferenced(foo)) { Q3Object_Dispose(foo); }
  1054. ; *    
  1055. ; *    Your application will crash and no one will buy it. Chapter 11 is 
  1056. ; *    never fun (unless you short the stock). Thanks.
  1057. ; 
  1058.  
  1059. ;
  1060. ; extern TQ3Boolean Q3Shared_IsReferenced(TQ3SharedObject sharedObject)
  1061. ;
  1062.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1063.         IMPORT_CFM_FUNCTION Q3Shared_IsReferenced
  1064.     ENDIF
  1065.  
  1066. ; 
  1067. ; *    Q3Shared_GetEditIndex
  1068. ; *        Returns the "serial number" of sharedObject. Usefuly for caching 
  1069. ; *        object information. Returns 0 on error.
  1070. ; *        
  1071. ; *        Hold onto this number to determine if an object has changed since you
  1072. ; *        last built your caches... To validate, do:
  1073. ; *        
  1074. ; *        if (Q3Shared_GetEditIndex(foo) == oldFooEditIndex) {
  1075. ; *            // Cache is valid
  1076. ; *        } else {
  1077. ; *            // Cache is invalid
  1078. ; *            RebuildSomeSortOfCache(foo);
  1079. ; *            oldFooEditIndex = Q3Shared_GetEditIndex(foo);
  1080. ; *        }
  1081. ; 
  1082.  
  1083. ;
  1084. ; extern unsigned long Q3Shared_GetEditIndex(TQ3SharedObject sharedObject)
  1085. ;
  1086.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1087.         IMPORT_CFM_FUNCTION Q3Shared_GetEditIndex
  1088.     ENDIF
  1089.  
  1090. ; 
  1091. ; *    Q3Shared_Edited
  1092. ; *        Bumps the "serial number" of sharedObject to a different value. This
  1093. ; *        call is intended to be used solely from a plug-in object which is 
  1094. ; *        shared. Call this whenever your private instance data changes.
  1095. ; *        
  1096. ; *        Returns kQ3Failure iff sharedObject is not a shared object, OR
  1097. ; *            QuickDraw 3D isn't initialized.
  1098. ; 
  1099.  
  1100. ;
  1101. ; extern TQ3Status Q3Shared_Edited(TQ3SharedObject sharedObject)
  1102. ;
  1103.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1104.         IMPORT_CFM_FUNCTION Q3Shared_Edited
  1105.     ENDIF
  1106.  
  1107.  
  1108. ; ******************************************************************************
  1109. ; **                                                                             **
  1110. ; **                                Shape Routines                                 **
  1111. ; **                                                                             **
  1112. ; ****************************************************************************
  1113.  
  1114. ; 
  1115. ; *    QuickDraw 3D 1.1 Note:
  1116. ; *
  1117. ; *    Shapes and Sets are now (sort of) polymorphic.
  1118. ; *
  1119. ; *        You may call Q3Shape_Foo or Q3Set_Foo on a shape or a set.
  1120. ; *        The following calls are identical, in implementation:
  1121. ; *
  1122. ; *            Q3Shape_GetElement            =    Q3Set_Get
  1123. ; *            Q3Shape_AddElement            =    Q3Set_Add
  1124. ; *            Q3Shape_ContainsElement        =    Q3Set_Contains
  1125. ; *            Q3Shape_GetNextElementType    =    Q3Set_GetNextElementType
  1126. ; *            Q3Shape_EmptyElements        =    Q3Set_Empty
  1127. ; *            Q3Shape_ClearElement        =    Q3Set_Clear
  1128. ; *
  1129. ; *    All of these calls accept a shape or a set as their first parameter.
  1130. ; *
  1131. ; *    The Q3Shape_GetSet and Q3ShapeSetSet calls are implemented via a new
  1132. ; *    element type kQ3ElementTypeSet. See the note above about 
  1133. ; *    kQ3ElementTypeSet;
  1134. ; *
  1135. ; *    It is important to note that the new Q3Shape_...Element... calls do not
  1136. ; *    create a set on a shape and then add the element to it. This data is
  1137. ; *    attached directly to the shape. Therefore, it is possible for an element
  1138. ; *    to exist on a shape without a set existing on it as well. 
  1139. ; *
  1140. ; *    In your application, if you attach an element to a shape like this:
  1141. ; *        (this isn't checking for errors for simplicity)
  1142. ; *
  1143. ; *        set = Q3Set_New();
  1144. ; *        Q3Set_AddElement(set, kMyElemType, &data);
  1145. ; *        Q3Shape_SetSet(shape, set);
  1146. ; *
  1147. ; *    You should retrieve it in the same manner:
  1148. ; *
  1149. ; *        Q3Shape_GetSet(shape, &set);
  1150. ; *        if (Q3Set_Contains(set, kMyElemType) == kTrue) {
  1151. ; *            Q3Set_Get(set, kMyElemType, &data);
  1152. ; *        }
  1153. ; *
  1154. ; *    Similarly, if you attach data to a shape with the new calls:
  1155. ; *
  1156. ; *        Q3Shape_AddElement(shape, kMyElemType, &data);
  1157. ; *
  1158. ; *    You should retrieve it in the same manner:
  1159. ; *
  1160. ; *        if (Q3Shape_ContainsElement(set, kMyElemType) == kTrue) {
  1161. ; *            Q3Shape_GetElement(set, kMyElemType, &data);
  1162. ; *        }
  1163. ; *
  1164. ; *    This really becomes an issue when dealing with version 1.0 and version 1.1 
  1165. ; *    metafiles.
  1166. ; *
  1167. ; *    When attempting to find a particular element on a shape, you should
  1168. ; *    first check with Q3Shape_GetNextElementType or Q3Shape_GetElement, then,
  1169. ; *    Q3Shape_GetSet(s, &set) (or Q3Shape_GetElement(s, kQ3ElementTypeSet, &set))
  1170. ; *    and then Q3Shape_GetElement(set, ...).
  1171. ; *
  1172. ; *    In terms of implementation, Q3Shape_SetSet and Q3Shape_GetSet should only be
  1173. ; *    used for sets of information that are shared among multiple shapes.
  1174. ; *    
  1175. ; *    Q3Shape_AddElement, Q3Shape_GetElement, etc. calls should only be used
  1176. ; *    for elements that are unique for a particular shape.
  1177. ; *    
  1178. ; 
  1179.  
  1180. ;
  1181. ; extern TQ3ObjectType Q3Shape_GetType(TQ3ShapeObject shape)
  1182. ;
  1183.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1184.         IMPORT_CFM_FUNCTION Q3Shape_GetType
  1185.     ENDIF
  1186.  
  1187. ;
  1188. ; extern TQ3Status Q3Shape_GetSet(TQ3ShapeObject shape, TQ3SetObject *theSet)
  1189. ;
  1190.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1191.         IMPORT_CFM_FUNCTION Q3Shape_GetSet
  1192.     ENDIF
  1193.  
  1194. ;
  1195. ; extern TQ3Status Q3Shape_SetSet(TQ3ShapeObject shape, TQ3SetObject theSet)
  1196. ;
  1197.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1198.         IMPORT_CFM_FUNCTION Q3Shape_SetSet
  1199.     ENDIF
  1200.  
  1201. ;
  1202. ; extern TQ3Status Q3Shape_AddElement(TQ3ShapeObject shape, TQ3ElementType theType, const void *data)
  1203. ;
  1204.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1205.         IMPORT_CFM_FUNCTION Q3Shape_AddElement
  1206.     ENDIF
  1207.  
  1208. ;
  1209. ; extern TQ3Status Q3Shape_GetElement(TQ3ShapeObject shape, TQ3ElementType theType, void *data)
  1210. ;
  1211.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1212.         IMPORT_CFM_FUNCTION Q3Shape_GetElement
  1213.     ENDIF
  1214.  
  1215. ;
  1216. ; extern TQ3Boolean Q3Shape_ContainsElement(TQ3ShapeObject shape, TQ3ElementType theType)
  1217. ;
  1218.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1219.         IMPORT_CFM_FUNCTION Q3Shape_ContainsElement
  1220.     ENDIF
  1221.  
  1222. ;
  1223. ; extern TQ3Status Q3Shape_GetNextElementType(TQ3ShapeObject shape, TQ3ElementType *theType)
  1224. ;
  1225.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1226.         IMPORT_CFM_FUNCTION Q3Shape_GetNextElementType
  1227.     ENDIF
  1228.  
  1229. ;
  1230. ; extern TQ3Status Q3Shape_EmptyElements(TQ3ShapeObject shape)
  1231. ;
  1232.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1233.         IMPORT_CFM_FUNCTION Q3Shape_EmptyElements
  1234.     ENDIF
  1235.  
  1236. ;
  1237. ; extern TQ3Status Q3Shape_ClearElement(TQ3ShapeObject shape, TQ3ElementType theType)
  1238. ;
  1239.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1240.         IMPORT_CFM_FUNCTION Q3Shape_ClearElement
  1241.     ENDIF
  1242.  
  1243.  
  1244.     ENDIF ; __QD3D__ 
  1245.  
  1246.